HTTP仕様
Request header |
Content-Type: application/json;charset=UTF-8 |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: application/json;charset=UTF-8 |
|
Status Code |
|
・E90010001
・E92000001
・E92000002
・E91099996
・E91099997
GetLinkplusUrlPayment 決済URL取得
決済画面表示に必要なURLを取得します。
リクエスト
geturlparam |
URL発行情報 |
|
---|---|---|
ShopID | 必須半角英数13桁
ショップID |
|
ShopPass | 必須半角英数64桁
ショップパスワード |
|
GuideMailSendFlag | 半角数字1桁
決済URL案内メール送信フラグお客様への決済URL案内メール送信有無を設定します。未設定の場合、メール送信を行いません。 0:メール送信しない(デフォルト) 1:メール送信する |
|
ThanksMailSendFlag | 半角数字1桁
購入ありがとうメール送信フラグお客様への購入ありがとうメール送信有無を設定します。未設定の場合、メール送信を行いません。 0:メール送信しない(デフォルト) 1:メール送信する |
|
BccSendMailAddress | 半角数字記号256桁
送信先メールアドレス(BCC)お客様に送信するメールをBCCで受け取りたい場合に設定します。 |
|
FromSendMailAddress | 半角数字記号256桁
送信元メールアドレス(FROM)送信元メールアドレス(FROM)、メール送信元名を指定したい場合に設定します。未指定の場合、当サービスのデフォルト値を使用します。管理画面にて加盟店様のデフォルト値を設定可能です。 メールの詳細はメール仕様をご覧ください。 |
|
FromSendMailName | 全半角40桁
メール送信元名送信元メールアドレス(FROM)、メール送信元名を指定したい場合に設定します。未指定の場合、当サービスのデフォルト値を使用します。管理画面にて加盟店様のデフォルト値を設定可能です。 メールの詳細はメール仕様をご覧ください。 |
|
SendMailAddress | 半角数字記号256桁
送信先メールアドレス(TO)お客様のメールアドレスを設定します。※URL案内メール送信フラグ、購入ありがとうメール送信フラグのどちらかに「1」を設定した場合、必須です。 |
|
CustomerName | 全半角40桁
顧客名お客様名を設定します。※URL案内メール送信フラグ、購入ありがとうメール送信フラグ、決済URL案内SMS送信フラグのいずれかに「1」を設定した場合、必須です。 |
|
TemplateNo | 半角数字1桁
テンプレートNo.管理画面でアップロードしたテンプレートファイルのNo.を指定します。※URL案内メール送信フラグ、購入ありがとうメール送信フラグ、決済URL案内SMS送信フラグのいずれかに「1」を設定した場合、必須です。 |
|
GuideSmsSendFlag | 半角数字1桁
決済URL案内SMS送信フラグお客様への決済URL案内SMS送信有無を設定します。未設定の場合、SMS送信を行いません。 0:SMS送信しない(デフォルト) 1:SMS送信する |
|
SMSTelno | 半角数字15桁
SMS配信先携帯電話番号SMS配信先の電話番号を設定します。※決済URL案内SMS送信フラグに「1」を設定した場合、必須です。 |
|
AuthenticationQuestion1 | 全半角50桁
本人認証質問文言1本人認証の質問1つ目を設定します。指定されている場合、本人認証が行われます。 ※本人認証答え1が指定されている場合、必須です。 |
|
AuthenticationAnswer1 | 全半角50桁
本人認証答え1本人認証の質問1つ目に対する答えを設定します。※本人認証質問文言1が指定されている場合、必須です。 |
|
AuthenticationQuestion2 | 全半角50桁
本人認証質問文言2本人認証の質問2つ目を設定します。指定されている場合、本人認証が行われます。 ※本人認証答え2が指定されている場合、必須です。 |
|
AuthenticationAnswer2 | 全半角50桁
本人認証答え2本人認証の質問2つ目に対する答えを設定します。※本人認証質問文言2が指定されている場合、必須です。 |
|
AuthenticationRetryMax | 半角数字2桁
本人認証リトライ最大回数本人認証失敗時に再入力可能な回数です。0~99を指定可能です。 管理画面で設定した値を使用します。 |
|
実行パラメータ項目 (決済共通部) |
実行パラメータ項目
リンクタイプ Plus決済画面表示および決済実行に必要な項目です。 |
|
{決済識別子} |
決済識別子各決済手段ごとに必要な取引情報のパラメータセットです。詳細は各決済手段の章をご覧ください。 |
API
GetLinkplusUrlPayment.json
リクエストパラメータ
{
"geturlparam":{
"ShopID":"tshop11223344",
"ShopPass":"PASSWORD",
"GuideMailSendFlag":"1",
"SendMailAddress":"sample@sample.co.jp",
"CustomerName":"サンプル 太郎",
"TemplateNo":"1",
"AuthenticationQuestion1":"本人認証質問サンプル",
"AuthenticationAnswer1":"本人認証答えサンプル"
},
"configid": "001",
"transaction": {
"OrderID": "sample-123456789",
"Amount": "100",
"Tax": "10"
},
"credit": {
"JobCd":"AUTH"
}
}
レスポンス
OrderID | 半角英数記号27桁
オーダーID |
|
---|---|---|
LinkUrl |
決済URL作成した決済URLが設定されます。 |
|
ProcessDate | 半角数字14桁
処理実行日時(yyyyMMddHHmmss形式) |
|
WarnList |
ワーニング情報 |
|
warnCode | 半角英数3桁
ワーニングコード |
|
warnInfo | 半角英数9桁
ワーニング詳細コード |
|
errCode | 半角英数3桁
エラーコード |
|
errInfo | 半角英数9桁
エラー詳細コード |
レスポンス:正常系
{
"OrderID": "sample-123456789",
"LinkUrl": "https://[ドメイン]/v2/plus/tshop11223344/checkout/0258d6e9232978d004bf776c26acb435c7bc9eca33b40798a714a9dde2dfe0c5",
"ProcessDate": "20200727142656"
}
レスポンス:異常系
[
{"errCode": "EZ1","errInfo": "EZ1004005"},
{"errCode": "EZ1","errInfo": "EZ1004001"},
{"errCode": "EZ1","errInfo": "EZ1005005"}
]
レスポンス:ワーニング時
(GuideMailSendFlagが1の場合もメールは送信されません)
(GuideMailSendFlagが1の場合もメールは送信されません)
{
"OrderID": "sample-123456789",
"LinkUrl": "https://[ドメイン]/v2/plus/tshop11223344/checkout/0258d6e9232978d004bf776c26acb435c7bc9eca33b40798a714a9dde2dfe0c5",
"ProcessDate": "20200727142656",
"WarnList": [
{"warnCode": "EZ4","warnInfo": "EZ4135014"}
]
}